---
title: (MODULE_NAME)
---

How to use this Python tool template:

- [ ] Substitute (MODULE_NAME) with the name of the tool (`command + F` is your friend here)
- [ ] Update links to point to the correct tool
- [ ] Under the details and features tables, update the ✅/❌ to reflect the actual capabilities of the tool
- [ ] Update the PyPi/registry package name if needed
- [ ] Update the API key environment variable name if needed

The template starts below this line...

This guide provides a quick overview for getting started with the (MODULE_NAME) [tool](/oss/langchain/tools). For a detailed listing of all (MODULE_NAME) features, paramaters, and configurations, head to the [(MODULE_NAME) API reference](link-goes-here).

## Overview

### Details

| Class | Package |  Serializable | [JS support](https://js.langchain.com/docs/integrations/chat/anthropic) | Downloads | Version |
| :--- | :--- | :---: | :---: |  :---: | :---: | :---: |
| [(MODULE_NAME)](link) | [langchain-(MODULE_NAME)](link) | beta/❌ | ✅/❌ | ![PyPI - Downloads](https://img.shields.io/pypi/dm/langchain-(MODULE_NAME)?style=flat-square&label=%20) | ![PyPI - Version](https://img.shields.io/pypi/v/langchain-(MODULE_NAME)?style=flat-square&label=%20) |

### Features

- List features here. Add icons if you'd like!

---

## Setup

To access the (MODULE_NAME) tool, you'll need to create a/an (MODULE_NAME) account, get an API key, and install the `langchain-(MODULE_NAME)` integration package.

### Credentials

```python Set API key icon="key"
import getpass
import os

if "(MODULE_NAME)_API_KEY" not in os.environ:
    os.environ["(MODULE_NAME)_API_KEY"] = getpass.getpass("Enter your (MODULE_NAME) API key: ")
```



It's also helpful (but not needed) to set up LangSmith for best-in-class observability/<Tooltip tip="Log each step of a model's execution to debug and improve it">tracing</Tooltip> of your tool calls. To enable automated tracing, set your [LangSmith](https://docs.smith.langchain.com/) API key:

```python Enable tracing icon="flask"
os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")
os.environ["LANGSMITH_TRACING"] = "true"
```

### Installation

The (MODULE_NAME) tool lives in the `langchain-(MODULE_NAME)` package:

<CodeGroup>
    ```python pip
    pip install -U langchain-(MODULE_NAME)
    ```
    ```python uv
    uv add langchain-(MODULE_NAME)
    ```
</CodeGroup>

---

## Instantiation

Now we can instantiate an instance of the (MODULE_NAME) tool with:

```python Initialize tool instance icon="robot"
from langchain_(MODULE_NAME) import (MODULE_NAME)

tool = (MODULE_NAME)(...)
```

---

## Invocation

### Directly

TODO: Describe what the tool args are, fill them in

```python Call tool icon="rocket"
tool.invoke({...})
```

### As a ToolCall

We can also invoke the tool with a model-generated `ToolCall`, in which case a `ToolMessage` will be returned:

```python ToolCall icon="toolbox"
# This is usually generated by a model, but we'll create a tool call directly for demo purposes.
model_generated_tool_call = {
    "args": {...},  # TODO: FILL IN
    "id": "1",
    "name": tool.name,
    "type": "tool_call",
}
tool.invoke(model_generated_tool_call)
```

### Within an agent

We can use our tool in an agent. For this we will need a model with tool-calling capabilities.

```python Agent with tool icon="robot"
# pip install -qU "langchain[anthropic]" to call the model
from langchain.agents import create_agent

tools = [tool]
agent = create_agent(
    model="anthropic:claude-3-7-sonnet-latest",
    tools=tools,
)

# Run the agent
agent.invoke(
    {"messages": [{"role": "user", "content": "INSERT QUERY"}]}
)
```

---

## TODO: Any functionality specific to this tool

Delete if not relevant.

Look at existing tool docs for examples, e.g.:

- [MCP Toolbox](/oss/integrations/tools/toolbox)
- [Discord](/oss/integrations/tools/discord)
- [DuckDuckGo Search](/oss/integrations/tools/ddg)

---

## API reference

For detailed documentation of all (MODULE_NAME) features and configurations, head to the [API reference](link-to-ref-page).
